Crate usvg

Expand description

usvg (micro SVG) is an SVG simplification tool.

Purpose

Imagine, that you have to extract some data from the SVG file, but your library/framework/language doesn’t have a good SVG library. And all you need is paths data.

You can try to export it by yourself (how hard can it be, right). All you need is an XML library (I’ll hope that your language has one). But soon you realize that paths data has a pretty complex format and a lot of edge-cases. And we didn’t mention attributes propagation, transforms, visibility flags, attribute values validation, XML quirks, etc. It will take a lot of time and code to implement this stuff correctly.

So, instead of creating a library that can be used from any language (impossible), usvg takes a different approach. It converts an input SVG to an extremely simple representation, which is still a valid SVG. And now, all you need is to convert your SVG to a simplified one via usvg and an XML library with some small amount of code.

Key features of the simplified SVG

No basic shapes (rect, circle, etc). Only paths
Simple paths:
- Only MoveTo, LineTo, CurveTo and ClosePath will be produced
- All path segments are in absolute coordinates
- No implicit segment commands
- All values are separated by space
All (supported) attributes are resolved. No implicit one
No use. Everything is resolved
No invisible elements
No invalid elements (like rect with negative/zero size)
No units (mm, em, etc.)
No comments
No DTD
No CSS (partial support)
No script (simply ignoring it)

Full spec can be found here.

Limitations

Currently, it’s not lossless. Some SVG features isn’t supported yet and will be ignored.
CSS support is minimal.
Scripting and animation isn’t supported and not planned.
a elements will be removed.
Unsupported elements:
- some filter-based elements
- font-based elements

Re-exports

pub use roxmltree;

pub use fontdb;

Modules

filter

A collection of SVG filters.

utils

Some useful utilities.

Structs

AspectRatio

Representation of the preserveAspectRatio attribute.

A generic gradient.

A clip-path element.

A 8-bit RGB color.

An enable-background.

Fill

A fill style.

Group

A group container.

Image

A raster image element.

ImageHrefResolver

An xlink:href resolver for <image> elements.

A linear gradient.

A mask element.

A non-zero f64.

An immutable, finite f64 that is known to be > 0.

NormalizedF64

An immutable, finite f64 in a 0..=1 range.

Options

Processing options.

OptionsRef

A reference to processing options.

Path

A path element.

PathBbox

A path bbox representation.

PathData

An SVG path data container.

PathSegmentsIter

A path segments iterator.

Pattern

A pattern element.

Point

A 2D point representation.

PositiveF64

An immutable, finite f64 that is known to be >= 0.

RadialGradient

A radial gradient.

Rect

A rect representation.

ScreenRect

A 2D screen rect representation.

ScreenSize

A 2D screen size representation.

Size

A 2D size representation.

Stop

Gradient’s stop element.

Stroke

A stroke style.

StrokeMiterlimit

A stroke-miterlimit value.

Transform

Representation of the <transform> type.

TransformedPath

An iterator over transformed path segments.

Tree

A nodes tree container.

ViewBox

View box.

XmlOptions

XML writing options.

Enums

Align

Representation of the align value of the preserveAspectRatio attribute.

List of all errors.

A fill rule.

Image fit options.

An embedded image kind.

ImageRendering

An image rendering method.

A line cap.

A line join.

Node’s kind.

A paint style.

Representation of the paint-order property.

PathCommand

A path command.

PathSegment

A path’s absolute segment.

ShapeRendering

A shape rendering method.

SpreadMethod

A spread method.

TextRendering

A text rendering method.

Units

An element units.

Visibility

A visibility property.

Traits

ApproxEq

A trait for approximate equality comparisons.

ApproxEqUlps

ApproxEqUlps is a trait for approximate equality comparisons. The associated type Flt is a floating point type which implements Ulps, and is required so that this trait can be implemented for compound types (e.g. vectors), not just for the floats themselves.

FuzzyEq

A trait for fuzzy/approximate equality comparisons of float numbers.

FuzzyZero

A trait for fuzzy/approximate comparisons of float numbers.

IsDefault

Checks that type has a default value.

IsValidLength

Checks that the current number is > 0.

NodeExt

Additional Node methods.

TransformFromBBox

Converts Rect into bbox Transform.